/*
 * Copyright (c) 2012 Jonathan Tyers
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package uk.org.uplink.guicemodulescanner;

import java.util.Set;

import uk.org.uplink.guicemodulescanner.configuration.Configuration;
import uk.org.uplink.guicemodulescanner.reflections.ReflectionsModuleScanner;
import uk.org.uplink.guicemodulescanner.reflections.ReflectionsModuleScannerFactory;

import com.google.inject.Module;

/**
 * Provides scanning for Guice Modules on the Java system classpath that have the {@code @}{@link AutoloadModule} annotation.
 * <p />
 * The behaviour of scanning can be customised using a {@link Configuration}.
 * 
 * @author jonny
 */
public final class ModuleScanner {
	/**
	 * Underlying scanner.
	 */
	private final ReflectionsModuleScanner reflectionsModuleScanner;

	/**
	 * Creates a {@link ModuleScanner} with the default configuration. This is equivalent to calling <tt>scanForModules(new Configuration())</tt>.
	 */
	public ModuleScanner() {
		this(new Configuration());
	}

	/**
	 * Creates a {@link ModuleScanner} with the given configuration.
	 */
	public ModuleScanner(final Configuration configuration) {
		reflectionsModuleScanner = ReflectionsModuleScannerFactory.create(configuration);
	}

	/**
	 * Finds and instantiate all classes on the classpath that have the {@code @}{@link AutoloadModule} annotation,
	 * using the default configuration.
	 * <p/>
	 * This is equivalent to calling <tt>scanForModules(new Configuration())</tt>.
	 * 
	 * @return the modules found
	 */
	public Set<Module> scanForModules() {
		return reflectionsModuleScanner.scanForModules();
	}

}
